Button 4 Click Driver

API for configuring and manipulating Button 4 Click driver. More...

Topics
	Button 4 Settings
	Settings of Button 4 Click driver.
	Button 4 MikroBUS Map
	MikroBUS pin mapping of Button 4 Click driver.

Functions
void	button4_cfg_setup (button4_cfg_t *cfg)
	Button 4 configuration object setup function.
err_t	button4_init (button4_t *ctx, button4_cfg_t *cfg)
	Button 4 initialization function.
uint8_t	button4_get_out_pin (button4_t *ctx)
	Button 4 get out pin function.

Detailed Description

API for configuring and manipulating Button 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

button4_cfg_setup()

void button4_cfg_setup

(

button4_cfg_t *

cfg

)

Button 4 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See button4_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

button4_get_out_pin()

uint8_t button4_get_out_pin

(

button4_t *

ctx

)

Button 4 get out pin function.

This function returns the OUT pin logic state.

Parameters

[in]

ctx

: Click context object. See button4_t object definition for detailed explanation.

Returns

• 0 - Button active,
• 1 - Button reset.

Note

None.

button4_init()

err_t button4_init	(	button4_t *	ctx,
		button4_cfg_t *	cfg )

Button 4 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See button4_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See button4_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.